<html>
<head><meta charset="utf-8"><title>Is the Rust book theme available for GitHub Pages? · general · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/index.html">general</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html">Is the Rust book theme available for GitHub Pages?</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="243325458"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243325458" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243325458">(Jun 20 2021 at 22:45)</a>:</h4>
<p>I really like the theme of <a href="https://doc.rust-lang.org/stable/book/">https://doc.rust-lang.org/stable/book/</a> and want to use it for <a href="https://bazelbuild.github.io/rules_rust/">https://bazelbuild.github.io/rules_rust/</a> since it's Rust rules for the Bazel build system but dont' know if that's doable through GitHub Pages. Would anyone know if that theme is transferable?</p>



<a name="243325796"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243325796" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> XAMPPRocky <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243325796">(Jun 20 2021 at 22:54)</a>:</h4>
<p><span class="user-mention" data-user-id="343063">@UebelAndre</span> The book is generated using <code>mdbook</code>, and it’s the default theme.</p>



<a name="243325797"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243325797" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> XAMPPRocky <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243325797">(Jun 20 2021 at 22:54)</a>:</h4>
<p><a href="https://rust-lang.github.io/mdBook/">https://rust-lang.github.io/mdBook/</a></p>



<a name="243326115"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326115" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326115">(Jun 20 2021 at 23:03)</a>:</h4>
<p>I'm brand new to github pages, is there a simple additon to the auto-generated <code>_config.yml</code> file I can add?<br>
Is <code>mdbook</code> an actual theme there?</p>



<a name="243326357"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326357" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> XAMPPRocky <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326357">(Jun 20 2021 at 23:10)</a>:</h4>
<p><span class="user-mention" data-user-id="343063">@UebelAndre</span> I’m not exactly sure what you’re asking for. You need a mdbook project to generate the documentation. I’m not familiar Bazel so I can’t help with that aspect. But if you can use GitHub Actions, I wrote a action to automatically deploy mdbook to GitHub pages for you. <a href="https://github.com/XAMPPRocky/deploy-mdbook">https://github.com/XAMPPRocky/deploy-mdbook</a></p>



<a name="243326377"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326377" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326377">(Jun 20 2021 at 23:11)</a>:</h4>
<p>This question doesn't have anything to do with Bazel. I'm just not aware of hwo GitHub Pages functions</p>



<a name="243326379"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326379" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326379">(Jun 20 2021 at 23:11)</a>:</h4>
<p>This action will probably get me what I want though</p>



<a name="243326381"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326381" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326381">(Jun 20 2021 at 23:11)</a>:</h4>
<p>gonna try it out</p>



<a name="243326557"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326557" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326557">(Jun 20 2021 at 23:16)</a>:</h4>
<p>also pretty new to github actions, how do I configure it?</p>



<a name="243326564"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243326564" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243326564">(Jun 20 2021 at 23:16)</a>:</h4>
<p>like, our docs are located in a <code>./docs</code> directory, does this action know about that?</p>



<a name="243328986"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243328986" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243328986">(Jun 21 2021 at 00:23)</a>:</h4>
<p><span class="user-mention" data-user-id="219696">@XAMPPRocky</span> do you know if mdbooks supports versioned docs?</p>



<a name="243329042"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243329042" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> XAMPPRocky <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243329042">(Jun 21 2021 at 00:25)</a>:</h4>
<p><span class="user-mention" data-user-id="343063">@UebelAndre</span> You need to set the <code>workspace</code> input variable to the directory if you want to use a different folder from the default.</p>



<a name="243329060"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243329060" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> XAMPPRocky <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243329060">(Jun 21 2021 at 00:25)</a>:</h4>
<p>I don’t think it natively supports versioned docs.</p>



<a name="243329137"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243329137" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> XAMPPRocky <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243329137">(Jun 21 2021 at 00:27)</a>:</h4>
<p>You could generate versioned docs yourself though by having mdbook output to <code>&lt;version&gt;</code> where version is whatever you’re using like a git tag or branch.</p>



<a name="243329612"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243329612" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243329612">(Jun 21 2021 at 00:40)</a>:</h4>
<p>Is there a way to reference the versioned directories within the docs?</p>



<a name="243329616"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243329616" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243329616">(Jun 21 2021 at 00:41)</a>:</h4>
<p>Like any kind of built in drop down?</p>



<a name="243329638"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243329638" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243329638">(Jun 21 2021 at 00:41)</a>:</h4>
<p><span class="user-mention" data-user-id="343063">@UebelAndre</span> no, but <a href="http://docs.rs">docs.rs</a> has some handling you could copy. I would be interested in pulling that out into a library but I think it's very unlikey it would ever be part of rustdoc proper</p>



<a name="243331126"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243331126" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243331126">(Jun 21 2021 at 01:22)</a>:</h4>
<p>yeah, the docs on <a href="http://docs.rs">docs.rs</a> is exactly what I would love to be able to mimic</p>



<a name="243364743"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243364743" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243364743">(Jun 21 2021 at 10:45)</a>:</h4>
<p><span class="user-mention" data-user-id="232545">@Joshua Nelson</span> Yeah, it'd be awesome if there were a way to independently generate documentation that looked like something hosted on <a href="http://docs.rs">docs.rs</a> the format is really nice</p>



<a name="243370110"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243370110" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243370110">(Jun 21 2021 at 11:43)</a>:</h4>
<p><span class="user-mention" data-user-id="343063">@UebelAndre</span> I'm happy to work with you on factoring out a library, but I won't have time to do it myself, you'd have to drive the project.</p>



<a name="243370193"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243370193" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243370193">(Jun 21 2021 at 11:44)</a>:</h4>
<p>Probably the simplest way is to split src/web into a different crate and then you can use it as a git dependency</p>



<a name="243371704"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243371704" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> UebelAndre <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243371704">(Jun 21 2021 at 12:00)</a>:</h4>
<p>I'll see if I can find a block of time to do that. But I'm pretty booked for the near-term. But it does sound like a fun project, so I'll ping you if I find the time to work on it :D</p>



<a name="243373116"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243373116" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243373116">(Jun 21 2021 at 12:13)</a>:</h4>
<p><span class="user-mention" data-user-id="343063">@UebelAndre</span> great! The best place to discuss it is in #docs-rs on the official discord server, that way the rest of the team can give input too</p>



<a name="243374491"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243374491" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Pietro Albini <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243374491">(Jun 21 2021 at 12:27)</a>:</h4>
<p>as I mentioned on discord, I'm not sure using the <a href="http://docs.rs">docs.rs</a> frontend is worth the effort</p>



<a name="243374573"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Is%20the%20Rust%20book%20theme%20available%20for%20GitHub%20Pages%3F/near/243374573" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Pietro Albini <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Is.20the.20Rust.20book.20theme.20available.20for.20GitHub.20Pages.3F.html#243374573">(Jun 21 2021 at 12:28)</a>:</h4>
<p>if you just want a dropdown to switch versions it's going to be easier to just roll your own</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>